Documentation for class image

Inherits from 	complex_object 

Properties declared in image 
	angle 
	horizontal_scale 
	save_only_filename 
	vertical_scale 

Class Methods declared in image 
	new 
	new_from_file(path) 

Methods declared in image 
	any 
		angle 
		duplicate 
		horizontal_scale 
		inspect 
		rename(name) 
		rotate_by(delta_angle) 
		rotate_to(angle) 
		save_only_filename 
		scale(x, y) 
		set_angle(angle) 
		set_horizontal_scale(scale) 
		set_save_only_filename(boolean) 
		set_vertical_scale(scale) 
		vertical_scale 
	get 
		angle 
		horizontal_scale 
		save_only_filename 
		vertical_scale 
	set 
		set_angle(angle) 
		set_horizontal_scale(scale) 
		set_save_only_filename(boolean) 
		set_vertical_scale(scale) 

Class 
#begin_class
image 
The class image is a sub-class of the class complex_object. 
An image object is initialized from a TIFF or EPS-file. Image objects may be scaled and rotated.
Images are used in pictures, buttons and button_cells.
#end_class

Properties 

#begin_property
angle 
Stores the angle of the image. 
The angle is always between 0 and 359.
#end_property

#begin_property
horizontal_scale 
Stores the horizontal scale of the image. The scale value 1.0 is the normal scale. A horizontal scale value less than 1.0 will result in a narrower image. A horizontal scale value higher than 1.0 will result in a wider image. 
#end_property

#begin_property
save_only_filename 
Stores a boolean value. If the value is true, the image is stored only as a filename of an image file. This will make your programs much smaller. 
If the value is false, the entire image is stored within the program.
Note: If you move the program to a new computer, the image filename may not reference an existing image file. The image will then be blank. 
#end_property

#begin_property
vertical_scale 
Stores the vertical scale of the image. The scale value 1.0 is the normal scale. A vertical scale value less than 1.0 will result in a shorter image. A vertical scale value higher than 1.0 will result in a taller image. 
#end_property

Methods 

#begin_method
angle 
Returns the angle property of the slide.
#end_method

#begin_method
duplicate 
Returns a new image object that is a copy of the image. 
Note: The system images cannot be duplicated. They return self.
#end_method

#begin_method
horizontal_scale 
Returns the horizontal_scale property of the slide.
#end_method

#begin_method
inspect 
Opens the inspector for the image.
#end_method

#begin_method
rename(name) 
Sets the name of the image object to the symbol name.
Returns self.
Ex:
i := {image}:new
i:rename(#my_image)
The image i can now also be referred to as
{image my_image}
#end_method

#begin_method
rotate_by(delta_angle) 
Sets the rotation of the image to the current angle + delta_angle.
Returns self.
Note: If you rotate the image, pictures with the image will not be resized nor redisplayed. To do that you can either send the rotate_by(delta_angle) message to the picture instead or you can send a size_to_fit message followed by a display message to all the pictures with the image.
Also see rotate_by(delta_angle) (picture), size_to_fit (picture) and display (graphic).
#end_method

#begin_method
rotate_to(angle) 
Sets the rotation of the image to angle.
Returns self.
Note: If you rotate the image, pictures with the image will not be resized nor redisplayed. To do that you can either send the rotate_to(angle) message to the picture instead or you can send a size_to_fit message followed by a display message to all the pictures with the image.
Also see rotate_to(angle) (picture), size_to_fit (picture) and display (graphic).
#end_method

#begin_method
save_only_filename 
Returns the save_only_filename property of the slide.
#end_method

#begin_method
scale(x, y) 
Sets the horizontal scaling to x and the vertical scaling to y.
Returns self.
Note: If you scale the image, pictures with the image will not be resized nor redisplayed. To do that you can either send the scale(x, y) message to the picture instead or you can send a size_to_fit message followed by a display message to all the pictures with the image.
Also see scale(x, y) (picture), size_to_fit (picture) and display (graphic).
#end_method

#begin_method
set_angle(angle) 
Sets the angle property to angle. 
Returns self.
#end_method

#begin_method
set_horizontal_scale(scale) 
Sets the horizontal scaling to scale.
Returns self.
Note: If you scale the image, pictures with the image will not be resized nor redisplayed.
Also see scale(x, y).
#end_method

#begin_method
set_save_only_filename(boolean) 
Sets the save_only_filename property to boolean. 
Returns self.
#end_method

#begin_method
set_vertical_scale(scale) 
Sets the vertical scaling to scale.
Returns self.
Note: If you scale the image, pictures with the image will not be resized nor redisplayed.
Also see scale(x, y).
#end_method

#begin_method
vertical_scale 
Returns the vertical_scale property of the slide.
#end_method

Class Methods 

#begin_class_method
new 
You should create new images with the new_from_file message.
Ex:
{image}:new
raises an exception
Images should be created by reading in a image definition from a TIFF or EPS file: use the new_from_file class method instead! 
#end_class_method

#begin_class_method
new_from_file(path) 
Returns a new image object with the image from the file path.
#end_class_method